Vcenter Ovf CertificateParams

Vcenter Ovf CertificateParams

The Vcenter Ovf CertificateParams schema contains information about the public key certificate used to sign the OVF package. This schema will only be returned if the OVF package is signed.

See POST /vcenter/ovf/library-item/{ovfLibraryItemId}?action=deploy and POST /vcenter/ovf/library-item/{ovfLibraryItemId}?action=filter.

JSON Example

{
    "issuer": "string",
    "subject": "string",
    "is_valid": false,
    "is_self_signed": false,
    "x509": "string",
    "warnings": [
        {
            "type": "string",
            "message": {
                "id": "string",
                "default_message": "string",
                "args": [
                    "string"
                ],
                "params": {
                    "params": {
                        "s": "string",
                        "dt": "string",
                        "i": 0,
                        "d": "number",
                        "l": "Vapi Std NestedLocalizableMessage Object",
                        "format": "string",
                        "precision": 0
                    }
                },
                "localized": "string"
            },
            "ignored": false
        }
    ],
    "type": "string"
}

string

issuer

Optional

Certificate issuer. For example: /C=US/ST=California/L=Palo Alto/O=VMware, Inc.

This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

string

subject

Optional

Certificate subject. For example: /C=US/ST=Massachusetts/L=Hopkinton/O=EMC Corporation/OU=EMC Avamar/CN=EMC Corporation.

This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

boolean

is_valid

Optional

Is the certificate chain validated.

This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

boolean

is_self_signed

Optional

Is the certificate self-signed.

This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

string

x509

Optional

The X509 representation of the certificate.

This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

array of Vcenter Ovf WarningInfo

warnings

Optional

The list of warnings raised for the OVF certificate used in this OVF package deployment. Any warning that is not ignored by the client will cause the OVF package deployment to fail.

This property was added in vSphere API 7.0.2.0.

This property is set only if the certificate has warnings when retrieving information about an OVF package by POST /vcenter/ovf/library-item/{ovfLibraryItemId}?action=filter. When the property is set, the Vcenter Ovf WarningInfo.ignored property can be updated before the OVF parameter is passed to POST /vcenter/ovf/library-item/{ovfLibraryItemId}?action=deploy to deploy the OVF package.

string

type

Optional

Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters schema.

This property must be provided in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.